-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Documentation: Order of messages #8326
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation: Order of messages #8326
Conversation
In pylint-dev#7162, "we decreed" that the `bad_code` goes first, then the `good_code`. Fixup current changes, to revert "back to standards". Additionally, tackle the comment here pylint-dev#8287 (comment) "Message emitted" is technically still code (`%-formatting`); let us make it stand out properly. Signed-off-by: Stavros Ntentos <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for working on this :) The warning that make the pipeline fail is : WARNING: Inline literal start-string without end-string.
. You can test locally with tox -e docs
or cd doc/;make html
Wrapping "Message emitted" in monospaced formatting, causes `W1507` (`pylint/checkers/stdlib.py`) to fail on a stray space. Fix that - as it seems to be the only outlier. (Might've been nice for a more formal check in the first place 🙏). Signed-off-by: Stavros Ntentos <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👌
🤖 According to the primer, this change has no effect on the checked open source code. 🤖🎉 This comment was generated for commit dd8d3da |
In #7162, "we decreed" that the
bad_code
goes first, then thegood_code
.Fixup current changes, to revert "back to standards".
Additionally, tackle the comment here
#8287 (comment)
"Message emitted" is technically still code (
%-formatting
); let us make it stand out properly.Type of Changes
Description
Refs #8287
Closes #8321